module api 2.1 docs#66
Conversation
|
Warning Review limit reached
More reviews will be available in 46 minutes and 24 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughAdds Companion 5.0 / API 2.1 documentation covering graphics elements, composite elements, layered preset overhaul, AbortSignal cancellation, action results, feedback ChangesAPI 2.1 & Module Development Docs
User-Facing Expression & Scripting Docs
CI Checkout Action Bump
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
21fc6c7 to
0f23a08
Compare
0f23a08 to
0ad03ae
Compare
Bumps [actions/checkout](https://github.com/actions/checkout) from 6 to 7. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v6...v7) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (5)
for-developers/module-development/api-changes/v2.1.md (2)
110-151: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueMinor: Element type list consistency check.
The graphics overhaul lists 8 element types (text, image, box, line, circle, gauge, group, composite). This matches
graphics-elements.mdwhich documents all 8. ✅One small thing: the "Gauge" description says "value-driven bar/ring meter" but
graphics-elements.mdalso documentsorientation: 'horizontal' | 'vertical' | 'ring'— the "bar" covers horizontal/vertical but you might want to be explicit that gauges can be horizontal bars, vertical bars, or rings. Not a blocker, just a thought for clarity.
226-226: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueStyle: "all of the functionality" → "all the functionality"
LanguageTool suggests removing "of" for conciseness. This is a minor style point — "all the functionality" reads more naturally.
- fallback for hosts which don't support all of the functionality of the module API (such as Bitfocus Buttons). + fallback for hosts which don't support all the functionality of the module API (such as Bitfocus Buttons).for-developers/module-development/connection-basics/presets.md (2)
247-309: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueLGTM! The internal actions and feedbacks documentation is comprehensive and matches v2.1.md. The example using
internal:wait,internal:logicIf, andinternal:customLogdemonstrates real usage.One minor note: the code example at lines 272-304 uses
;[which is slightly unusual — it's to avoid ASI issues with the leading[. This is fine but might confuse some readers. Maybe add a brief comment?```ts - ;[ + // Note the leading semicolon to avoid automatic semicolon insertion issues + ;[ {
388-423: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueLGTM! The alternatives section matches v2.1.md and provides a good layered+simple fallback example.
Addressing the static analysis hint at line 392:
- fallback for hosts with a more restrictive drawing, or don't support all of the functionality of the module API (such as Bitfocus Buttons). + fallback for hosts with a more restrictive drawing, or don't support all the functionality of the module API (such as Bitfocus Buttons).user-guide/4_expressions/functions.md (1)
349-388: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueConsider clarifying
objectKeys/objectValuesbehavior with arrays.The docs note these work on "an object (or array)". For arrays,
objectKeysreturns string indices ("0","1"...) which can surprise users expecting numeric indices. A brief note or example would help avoid confusion.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 123b2b54-6b02-4208-b461-d4b02c05a245
📒 Files selected for processing (16)
.github/workflows/build-pr.yaml.github/workflows/deploy.yaml.github/workflows/lint.yamlfor-developers/module-development/api-changes/v2.1.mdfor-developers/module-development/connection-basics/actions.mdfor-developers/module-development/connection-basics/composite-elements.mdfor-developers/module-development/connection-basics/feedbacks.mdfor-developers/module-development/connection-basics/graphics-elements.mdfor-developers/module-development/connection-basics/presets-1.x.mdfor-developers/module-development/connection-basics/presets.mdfor-developers/module-development/connection-basics/variables.mdfor-developers/module-development/module-lifecycle/updating-nodejs.mdfor-developers/module-development/module-setup/manifest.json.mduser-guide/4_expressions/functions.mduser-guide/4_expressions/index.mduser-guide/4_expressions/scripting.md
Some drafting of the api changelog for 2.1
Summary by CodeRabbit
Documentation
Chores